home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / libraries / mui20dev.lha / MUI / Developer / Autodocs / MUI_Listview.doc < prev    next >
Text File  |  1994-02-11  |  4KB  |  140 lines
  1. TABLE OF CONTENTS
  2.  
  3. Listview.mui/Listview.mui
  4. Listview.mui/MUIA_Listview_ClickColumn
  5. Listview.mui/MUIA_Listview_DefClickColumn
  6. Listview.mui/MUIA_Listview_DoubleClick
  7. Listview.mui/MUIA_Listview_Input
  8. Listview.mui/MUIA_Listview_List
  9. Listview.mui/MUIA_Listview_MultiSelect
  10. Listview.mui/MUIA_Listview_SelectChange
  11. Listview.mui/Listview.mui
  12.  
  13. It's important to know that MUI makes a difference
  14. between a list and a listview. A list is just a
  15. collection of some entries and is part of a listview,
  16. which attaches a scrollbar and input handling to
  17. the list.
  18.  
  19. During object creation time, you have to be careful
  20. not specifying listview tags for the list object
  21. or list tags for the listview object, both versions
  22. won't work. Once the objects are setup, you can
  23. of course talk to the listview as if it was the
  24. list directly.
  25. Listview.mui/MUIA_Listview_ClickColumn
  26.  
  27.     NAME
  28.     MUIA_Listview_ClickColumn -- [..G], LONG
  29.  
  30.     FUNCTION
  31.     When using a multi column list, this attribute contains the number of
  32.     the column where the user clicked.
  33.  
  34.     SEE ALSO
  35.     MUIA_Listview_DefClickColumn
  36. Listview.mui/MUIA_Listview_DefClickColumn
  37.  
  38.     NAME
  39.     MUIA_Listview_DefClickColumn -- [ISG], LONG
  40.  
  41.     FUNCTION
  42.     When the listview is controlled with the keyboard and the user
  43.     presses RETURN, the value given here will be used as default
  44.     for MUIA_Listview_ClickColumn.
  45.  
  46.     SEE ALSO
  47.     MUIA_Listview_ClickColumn
  48. Listview.mui/MUIA_Listview_DoubleClick
  49.  
  50.     NAME
  51.     MUIA_Listview_DoubleClick -- [I.G], BOOL
  52.  
  53.     FUNCTION
  54.     This attribute is set to TRUE whenever the user
  55.     double clicks on an entry in the list.
  56.  
  57.     SEE ALSO
  58.     MUIA_Listview_SelectChange
  59. Listview.mui/MUIA_Listview_Input
  60.  
  61.     NAME
  62.     MUIA_Listview_Input -- [I..], BOOL
  63.  
  64.     FUNCTION
  65.     Setting this to FALSE will result in a read only
  66.     list view. Defaults to TRUE.
  67.  
  68.     SEE ALSO
  69.     MUIA_Listview_MultiSelect
  70. Listview.mui/MUIA_Listview_List
  71.  
  72.     NAME
  73.     MUIA_Listview_List -- [I..], Object *
  74.  
  75.     FUNCTION
  76.     Every listview needs a list object as child.
  77.     Specify it here.
  78.  
  79.     As every other child, it will get disposes when
  80.     its parent object is disposed.
  81.  
  82.     EXAMPLE
  83.     ListviewObject,
  84.        MUIA_Listview_Input, FALSE,
  85.        MUIA_Listview_List , ListObject,
  86.           ReadListFrame,
  87.           MUIA_List_Format       , ",,",
  88.           End,
  89.        End;
  90.  
  91.     SEE ALSO
  92.     MUIA_Listview_Input
  93. Listview.mui/MUIA_Listview_MultiSelect
  94.  
  95.     NAME
  96.     MUIA_Listview_MultiSelect -- [I..], LONG
  97.  
  98.     SPECIAL INPUTS
  99.     MUIV_Listview_MultiSelect_None
  100.     MUIV_Listview_MultiSelect_Default
  101.     MUIV_Listview_MultiSelect_Shifted
  102.     MUIV_Listview_MultiSelect_Always
  103.  
  104.     FUNCTION
  105.     Four possibilities exist for a listviews multi select
  106.     capabilities:
  107.  
  108.     MUIV_Listview_MultiSelect_None:
  109.        The listview cannot multiselect at all.
  110.  
  111.     MUIV_Listview_MultiSelect_Default:
  112.        The multi select type (with or without shift) depends on
  113.        the users preferences setting.
  114.  
  115.     MUIV_Listview_MultiSelect_Shifted:
  116.        Overrides the users prefs, multi selecting only together
  117.        with shift key.
  118.  
  119.     MUIV_Listview_MultiSelect_Always:
  120.        Overrides the users prefs, multi selecting without shift key.
  121.  
  122.     Please do *not* override the users prefs unless you have a
  123.     good reason!
  124.  
  125.     SEE ALSO
  126.     MUIA_List_MultiTestHook
  127. Listview.mui/MUIA_Listview_SelectChange
  128.  
  129.     NAME
  130.     MUIA_Listview_SelectChange -- [..G], BOOL
  131.  
  132.     FUNCTION
  133.     This attribute is set to TRUE whenever the selection state
  134.     of one or more items in the list is changing. You can
  135.     use this e.g. if you want to display the number of
  136.     selected items in a status line.
  137.  
  138.     SEE ALSO
  139.     MUIA_List_MultiSelect
  140.